Update documents.rst #1514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

ibrahim-ogunbiyi wants to merge 1 commit into python-openxml:master

from ibrahim-ogunbiyi:patch-2

Open

Update documents.rst #1514

ibrahim-ogunbiyi wants to merge 1 commit into python-openxml:master from ibrahim-ogunbiyi:patch-2

Conversation

@ibrahim-ogunbiyi

Copy link

@ibrahim-ogunbiyi ibrahim-ogunbiyi commented Aug 21, 2025

I think it's best to replace StringIO with BytesIO since we are working with bytes. This ensures that beginners, or anyone skimming the documentation and copying code, end up with correct and functional code.

@ibrahim-ogunbiyi


 Update documents.rst

fe4be5a

I think it's best to replace `StringIO` with `BytesIO` since we are working with bytes. This ensures that beginners, or anyone skimming the documentation and copying code, end up with correct and functional code.

scanny

scanny reviewed

Aug 21, 2025

View reviewed changes

docs/user/documents.rst

with open('foobar.docx', 'rb') as f:

source_stream = StringIO(f.read())

source_stream = BytesIO(f.read())

Copy link

Contributor

@scanny scanny Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, interesting. I'm sure this is an artifact of this documentation being written during the Python 2 era, when StringIO actually meant "read bytes".

I'll put it on the shortlist and fix it up next time I'm in there.